package se.janlindblom.ordning.typ.samling;

/**
 * $Id: Ones.java 125 2010-01-04 19:16:13Z lindblom.jan $
 * 
 * Copyright (c) 2009, Jan Lindblom
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * * Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * 
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * 
 * * Neither the name of the project nor the names of its contributors may be
 *   used to endorse or promote products derived from this software without
 *   specific prior written permission.
 *   
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 */

import java.util.Stack;

import se.janlindblom.ordning.typ.Minute;

/**
 * @author Jan Lindblom (lindblom.jan@gmail.com)
 * @version $Rev: 125 $
 */
public class Ones {
	private Stack<Minute> ones;
	private int capacity;
	private int size;

	/**
	 * Creates an empty Ones with room for 60 {@link Minute}s.
	 */
	public Ones() {
		ones = new Stack<Minute>();
		capacity = 60;
		size = 0;
	}
	
	/**
	 * Creates an empty Ones with the given capacity.
	 * 
	 * @param capacity the capacity of this Ones
	 */
	public Ones(int capacity) {
		ones = new Stack<Minute>();
		this.capacity = capacity;
		size = 0;
	}
	
	/**
	 * Pushes a {@link Minute} to the stack.
	 * 
	 * @param one the {@link Minute} to push
	 * @return the pushed {@link Minute} or null if this Ones if full
	 */
	public Minute push(Minute one) {
		if (this.capacity() > 0) {
			this.size++;
			this.capacity--;
			return ones.push(one);
		}
		return null;
	}
	
	/**
	 * Pops a {@link Minute} from the stack.
	 * 
	 * @return the popped {@link Minute}
	 */
	public Minute pop() {
		return ones.pop();
	}
	
	/**
	 * Returns the capacity of this Ones.
	 * 
	 * @return the capacity of this Ones
	 */
	public int capacity() {
		return this.capacity;
	}
}
